Reads the alias address from an EtherCAT slave.
Namespace: IntervalZero.KINGSTAR.Local.Api
Assembly: IntervalZero.KINGSTAR.Local.Api (in IntervalZero.KINGSTAR.Local.dll) Version: 4.4.0.0
Syntax
public KsCommandStatus<ushort> ReadSlaveAlias(
int SlaveId
)Public Function ReadSlaveAlias(
SlaveId As Integer
) As KsCommandStatus(Of UShort)Parameters
SlaveId
Type: int
The slave index. This index value is automatically assigned by the KINGSTAR master when the EtherCAT network starts, based on the physical connection order. The first device connected directly to the master is assigned Index 0, followed by Index 1, Index 2, and so on. These indexes remain consistent within the slave array even if devices are added, removed, or reconnected. Please refer to the use cases in HotConnect, Repair, and Restart for more details.
Return value
Type: KsCommandStatus<ushort>
Returns the KsCommandStatus class and an unsigned short integer value.
Usable EtherCAT states
ecatInit, ecatPreOP, ecatSafeOP, ecatOP
Examples
N/A
See also